Node.js

To get started right away without having to build an app from scratch, explore with the Ditto ready-to-use demo task app.

For a complete overview of the platforms, transports, and devices the JavaScript SDK supports, select Node.js from the Directory of Compatibility Maps.

For the API reference, see Ditto JS SDK v4.7.1.

Prerequisites

Before you can install Ditto, you must have the following:

• Ditto access credentials

• Node.js active long-term support (LTS) version 18.x or 20.x

• Linux, macOS version 11 (or later), or Windows version 10 (or later)

• Git

• Integrated developer environment (IDE)

• To get your access credentials, see Getting Playground Token Credentials.

• You can use any IDE you prefer; however, for optimal compatibility with the platform, Ditto recommends using Visual Studio Code.

Installing the Demo Task App

To install Ditto in your environment, install and set up Ditto, and authenticate your client identity with the Big Peer:

1. Clone the getditto > template-app-nodejs-todo repository from GitHub:

   bash

   git clone https://github.com/getditto/template-app-nodejs-todo/
   

2. Install the required dependencies:

   bash

   npm install
   

3. Open the project in your IDE, and then open the index.ts file. For example, if using Visual Studio Code:

   bash

   code .
   

4. In line 14 of the index.ts file, replace ‘YOUR_APP_ID’ and ‘YOUR_TOKEN’ with your app ID and playground token. (See Getting Playground Token Credentials)

   bash

   code .
   

5. In line 14 of the index.ts file, replace ‘YOUR_APP_ID’ and ‘YOUR_TOKEN’ with your app ID and playground token. (See Getting Playground Token Credentials)

   TypeScript

   // replace YOUR_APP_ID and YOUR_TOKEN with p
   ditto = new Ditto({ type: 'onlinePlayground', appID: 'YOUR_APP_ID', token: 'YOUR_TOKEN' })
   

6. Build the demo task app:

   bash

   npm run build
   

7. Interact with the demo task app and simulate real-time peer-to-peer replication by running the demo task app in two or more separate terminals (one for each virtual peer):

   bash

   node index.js
   

8. Using the commands that automatically appear in each of your terminals, add, remove, and modify documents as desired.

9. If you want to observe your changes sync with the cloud-optional deployment, the Big Peer, open the data browser in the Ditto portal.